<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>xmpp</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;xmpp
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="xmpp-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="xmpp-module.html">Package xmpp</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-comment"># $Id: __init__.py,v 1.9 2005/03/07 09:34:51 snakeru Exp $</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-docstring">All features of xmpppy library contained within separate modules.</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-docstring">At present there are modules:</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"><tt class="py-docstring">simplexml - XML handling routines</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-docstring">protocol - jabber-objects (I.e. JID and different stanzas and sub-stanzas) handling routines.</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"><tt class="py-docstring">debug - Jacob Lundquist's debugging module. Very handy if you like colored debug.</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line"><tt class="py-docstring">auth - Non-SASL and SASL stuff. You will need it to auth as a client or transport.</tt> </tt>
<a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line"><tt class="py-docstring">transports - low level connection handling. TCP and TLS currently. HTTP support planned.</tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"><tt class="py-docstring">roster - simple roster for use in clients.</tt> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"><tt class="py-docstring">dispatcher - decision-making logic. Handles all hooks. The first who takes control over fresh stanzas.</tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"><tt class="py-docstring">features - different stuff that didn't worths separating into modules</tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line"><tt class="py-docstring">browser - DISCO server framework. Allows to build dynamic disco tree.</tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-docstring">filetransfer - Currently contains only IBB stuff. Can be used for bot-to-bot transfers.</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line"><tt class="py-docstring">Most of the classes that is defined in all these modules is an ancestors of </tt> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"><tt class="py-docstring">class PlugIn so they share a single set of methods allowing you to compile </tt> </tt>
<a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line"><tt class="py-docstring">a featured XMPP client. For every instance of PlugIn class the 'owner' is the class</tt> </tt>
<a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line"><tt class="py-docstring">in what the plug was plugged. While plugging in such instance usually sets some</tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line"><tt class="py-docstring">methods of owner to it's own ones for easy access. All session specific info stored</tt> </tt>
<a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line"><tt class="py-docstring">either in instance of PlugIn or in owner's instance. This is considered unhandy</tt> </tt>
<a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line"><tt class="py-docstring">and there are plans to port 'Session' class from xmppd.py project for storing all</tt> </tt>
<a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line"><tt class="py-docstring">session-related info. Though if you are not accessing instances variables directly</tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line"><tt class="py-docstring">and use only methods for access all values you should not have any problems.</tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line"> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Module xmpp.simplexml=xmpp.simplexml-module.html"><a title="xmpp.simplexml" class="py-name" href="#" onclick="return doclink('link-0', 'simplexml', 'link-0');">simplexml</a></tt><tt class="py-op">,</tt><tt id="link-1" class="py-name" targets="Module xmpp.protocol=xmpp.protocol-module.html"><a title="xmpp.protocol" class="py-name" href="#" onclick="return doclink('link-1', 'protocol', 'link-1');">protocol</a></tt><tt class="py-op">,</tt><tt id="link-2" class="py-name" targets="Module xmpp.debug=xmpp.debug-module.html"><a title="xmpp.debug" class="py-name" href="#" onclick="return doclink('link-2', 'debug', 'link-2');">debug</a></tt><tt class="py-op">,</tt><tt id="link-3" class="py-name" targets="Module xmpp.auth=xmpp.auth-module.html,Method xmpp.auth.SASL.auth()=xmpp.auth.SASL-class.html#auth,Method xmpp.client.Client.auth()=xmpp.client.Client-class.html#auth,Method xmpp.client.Component.auth()=xmpp.client.Component-class.html#auth"><a title="xmpp.auth
xmpp.auth.SASL.auth
xmpp.client.Client.auth
xmpp.client.Component.auth" class="py-name" href="#" onclick="return doclink('link-3', 'auth', 'link-3');">auth</a></tt><tt class="py-op">,</tt><tt id="link-4" class="py-name" targets="Module xmpp.transports=xmpp.transports-module.html"><a title="xmpp.transports" class="py-name" href="#" onclick="return doclink('link-4', 'transports', 'link-4');">transports</a></tt><tt class="py-op">,</tt><tt id="link-5" class="py-name" targets="Module xmpp.roster=xmpp.roster-module.html"><a title="xmpp.roster" class="py-name" href="#" onclick="return doclink('link-5', 'roster', 'link-5');">roster</a></tt><tt class="py-op">,</tt><tt id="link-6" class="py-name" targets="Module xmpp.dispatcher=xmpp.dispatcher-module.html"><a title="xmpp.dispatcher" class="py-name" href="#" onclick="return doclink('link-6', 'dispatcher', 'link-6');">dispatcher</a></tt><tt class="py-op">,</tt><tt id="link-7" class="py-name" targets="Module xmpp.features=xmpp.features-module.html"><a title="xmpp.features" class="py-name" href="#" onclick="return doclink('link-7', 'features', 'link-7');">features</a></tt><tt class="py-op">,</tt><tt id="link-8" class="py-name" targets="Module xmpp.browser=xmpp.browser-module.html"><a title="xmpp.browser" class="py-name" href="#" onclick="return doclink('link-8', 'browser', 'link-8');">browser</a></tt><tt class="py-op">,</tt><tt id="link-9" class="py-name" targets="Module xmpp.filetransfer=xmpp.filetransfer-module.html"><a title="xmpp.filetransfer" class="py-name" href="#" onclick="return doclink('link-9', 'filetransfer', 'link-9');">filetransfer</a></tt><tt class="py-op">,</tt><tt id="link-10" class="py-name" targets="Module xmpp.commands=xmpp.commands-module.html"><a title="xmpp.commands" class="py-name" href="#" onclick="return doclink('link-10', 'commands', 'link-10');">commands</a></tt> </tt>
<a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-11" class="py-name" targets="Module xmpp.client=xmpp.client-module.html"><a title="xmpp.client" class="py-name" href="#" onclick="return doclink('link-11', 'client', 'link-11');">client</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-12" class="py-name"><a title="xmpp.protocol" class="py-name" href="#" onclick="return doclink('link-12', 'protocol', 'link-1');">protocol</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Sat Dec 15 22:25:28 2007
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
